home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / kleo / encryptjob.h < prev    next >
Encoding:
C/C++ Source or Header  |  2005-09-10  |  3.1 KB  |  93 lines
  1. /*
  2.     encryptjob.h
  3.  
  4.     This file is part of libkleopatra, the KDE keymanagement library
  5.     Copyright (c) 2004 KlarΣlvdalens Datakonsult AB
  6.  
  7.     Libkleopatra is free software; you can redistribute it and/or
  8.     modify it under the terms of the GNU General Public License as
  9.     published by the Free Software Foundation; either version 2 of the
  10.     License, or (at your option) any later version.
  11.  
  12.     Libkleopatra is distributed in the hope that it will be useful,
  13.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  14.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15.     General Public License for more details.
  16.  
  17.     You should have received a copy of the GNU General Public License
  18.     along with this program; if not, write to the Free Software
  19.     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
  20.  
  21.     In addition, as a special exception, the copyright holders give
  22.     permission to link the code of this program with any edition of
  23.     the Qt library by Trolltech AS, Norway (or with modified versions
  24.     of Qt that use the same license as Qt), and distribute linked
  25.     combinations including the two.  You must obey the GNU General
  26.     Public License in all respects for all of the code used other than
  27.     Qt.  If you modify this file, you may extend this exception to
  28.     your version of the file, but you are not obligated to do so.  If
  29.     you do not wish to do so, delete this exception statement from
  30.     your version.
  31. */
  32.  
  33. #ifndef __KLEO_ENCRYPTJOB_H__
  34. #define __KLEO_ENCRYPTJOB_H__
  35.  
  36. #include "job.h"
  37.  
  38. #include <qcstring.h>
  39.  
  40. #include <vector>
  41.  
  42. namespace GpgME {
  43.   class Error;
  44.   class Key;
  45.   class EncryptionResult;
  46. }
  47.  
  48.  
  49. namespace Kleo {
  50.  
  51.   /**
  52.      @short An abstract base class for asynchronous encrypters
  53.  
  54.      To use a EncryptJob, first obtain an instance from the
  55.      CryptoBackend implementation, connect the progress() and result()
  56.      signals to suitable slots and then start the encryption with a
  57.      call to start(). This call might fail, in which case the
  58.      EncryptJob instance will have scheduled it's own destruction with
  59.      a call to QObject::deleteLater().
  60.  
  61.      After result() is emitted, the EncryptJob will schedule it's own
  62.      destruction by calling QObject::deleteLater().
  63.   */
  64.   class EncryptJob : public Job {
  65.     Q_OBJECT
  66.   protected:
  67.     EncryptJob( QObject * parent, const char * name );
  68.   public:
  69.     ~EncryptJob();
  70.  
  71.     /**
  72.        Starts the encryption operation. \a recipients is the a list of
  73.        keys to encrypt \a plainText to. Empty (null) keys are ignored.
  74.  
  75.        If \a alwaysTrust is true, validity checking for the keys will
  76.        not be performed, but full validity assumed for all keys
  77.        without further checks.
  78.     */
  79.     virtual GpgME::Error start( const std::vector<GpgME::Key> & recipients,
  80.                 const QByteArray & plainText, bool alwaysTrust=false ) = 0;
  81.  
  82.     virtual GpgME::EncryptionResult exec( const std::vector<GpgME::Key> & recipients,
  83.                       const QByteArray & plainText,
  84.                       bool alwaysTrust, QByteArray & cipherText ) = 0;
  85.  
  86.   signals:
  87.     void result( const GpgME::EncryptionResult & result, const QByteArray & cipherText );
  88.   };
  89.  
  90. }
  91.  
  92. #endif // __KLEO_ENCRYPTJOB_H__
  93.